<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang3;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.ArrayList;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.Arrays;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.LinkedHashMap;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.Map;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.EnumSet;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;p&gt;Utility library to provide helper methods for Java enums.&lt;/p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     *<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;p&gt;#ThreadSafe#&lt;/p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     *<a name="line.30"></a>
<FONT color="green">031</FONT>     * @since 3.0<a name="line.31"></a>
<FONT color="green">032</FONT>     * @version $Id: EnumUtils.java 1199894 2011-11-09 17:53:59Z ggregory $<a name="line.32"></a>
<FONT color="green">033</FONT>     */<a name="line.33"></a>
<FONT color="green">034</FONT>    public class EnumUtils {<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>        /**<a name="line.36"></a>
<FONT color="green">037</FONT>         * This constructor is public to permit tools that require a JavaBean<a name="line.37"></a>
<FONT color="green">038</FONT>         * instance to operate.<a name="line.38"></a>
<FONT color="green">039</FONT>         */<a name="line.39"></a>
<FONT color="green">040</FONT>        public EnumUtils() {<a name="line.40"></a>
<FONT color="green">041</FONT>        }<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * &lt;p&gt;Gets the {@code Map} of enums by name.&lt;/p&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>         *<a name="line.45"></a>
<FONT color="green">046</FONT>         * &lt;p&gt;This method is useful when you need a map of enums by name.&lt;/p&gt;<a name="line.46"></a>
<FONT color="green">047</FONT>         *<a name="line.47"></a>
<FONT color="green">048</FONT>         * @param &lt;E&gt; the type of the enumeration<a name="line.48"></a>
<FONT color="green">049</FONT>         * @param enumClass  the class of the enum to query, not null<a name="line.49"></a>
<FONT color="green">050</FONT>         * @return the modifiable map of enum names to enums, never null<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; Map&lt;String, E&gt; getEnumMap(Class&lt;E&gt; enumClass) {<a name="line.52"></a>
<FONT color="green">053</FONT>            Map&lt;String, E&gt; map = new LinkedHashMap&lt;String, E&gt;();<a name="line.53"></a>
<FONT color="green">054</FONT>            for (E e: enumClass.getEnumConstants()) {<a name="line.54"></a>
<FONT color="green">055</FONT>                map.put(e.name(), e);<a name="line.55"></a>
<FONT color="green">056</FONT>            }<a name="line.56"></a>
<FONT color="green">057</FONT>            return map;<a name="line.57"></a>
<FONT color="green">058</FONT>        }<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>        /**<a name="line.60"></a>
<FONT color="green">061</FONT>         * &lt;p&gt;Gets the {@code List} of enums.&lt;/p&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>         *<a name="line.62"></a>
<FONT color="green">063</FONT>         * &lt;p&gt;This method is useful when you need a list of enums rather than an array.&lt;/p&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>         *<a name="line.64"></a>
<FONT color="green">065</FONT>         * @param &lt;E&gt; the type of the enumeration<a name="line.65"></a>
<FONT color="green">066</FONT>         * @param enumClass  the class of the enum to query, not null<a name="line.66"></a>
<FONT color="green">067</FONT>         * @return the modifiable list of enums, never null<a name="line.67"></a>
<FONT color="green">068</FONT>         */<a name="line.68"></a>
<FONT color="green">069</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; List&lt;E&gt; getEnumList(Class&lt;E&gt; enumClass) {<a name="line.69"></a>
<FONT color="green">070</FONT>            return new ArrayList&lt;E&gt;(Arrays.asList(enumClass.getEnumConstants()));<a name="line.70"></a>
<FONT color="green">071</FONT>        }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>        /**<a name="line.73"></a>
<FONT color="green">074</FONT>         * &lt;p&gt;Checks if the specified name is a valid enum for the class.&lt;/p&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>         *<a name="line.75"></a>
<FONT color="green">076</FONT>         * &lt;p&gt;This method differs from {@link Enum#valueOf} in that checks if the name is<a name="line.76"></a>
<FONT color="green">077</FONT>         * a valid enum without needing to catch the exception.&lt;/p&gt;<a name="line.77"></a>
<FONT color="green">078</FONT>         *<a name="line.78"></a>
<FONT color="green">079</FONT>         * @param &lt;E&gt; the type of the enumeration<a name="line.79"></a>
<FONT color="green">080</FONT>         * @param enumClass  the class of the enum to query, not null<a name="line.80"></a>
<FONT color="green">081</FONT>         * @param enumName   the enum name, null returns false<a name="line.81"></a>
<FONT color="green">082</FONT>         * @return true if the enum name is valid, otherwise false<a name="line.82"></a>
<FONT color="green">083</FONT>         */<a name="line.83"></a>
<FONT color="green">084</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; boolean isValidEnum(Class&lt;E&gt; enumClass, String enumName) {<a name="line.84"></a>
<FONT color="green">085</FONT>            if (enumName == null) {<a name="line.85"></a>
<FONT color="green">086</FONT>                return false;<a name="line.86"></a>
<FONT color="green">087</FONT>            }<a name="line.87"></a>
<FONT color="green">088</FONT>            try {<a name="line.88"></a>
<FONT color="green">089</FONT>                Enum.valueOf(enumClass, enumName);<a name="line.89"></a>
<FONT color="green">090</FONT>                return true;<a name="line.90"></a>
<FONT color="green">091</FONT>            } catch (IllegalArgumentException ex) {<a name="line.91"></a>
<FONT color="green">092</FONT>                return false;<a name="line.92"></a>
<FONT color="green">093</FONT>            }<a name="line.93"></a>
<FONT color="green">094</FONT>        }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /**<a name="line.96"></a>
<FONT color="green">097</FONT>         * &lt;p&gt;Gets the enum for the class, returning {@code null} if not found.&lt;/p&gt;<a name="line.97"></a>
<FONT color="green">098</FONT>         *<a name="line.98"></a>
<FONT color="green">099</FONT>         * &lt;p&gt;This method differs from {@link Enum#valueOf} in that it does not throw an exception<a name="line.99"></a>
<FONT color="green">100</FONT>         * for an invalid enum name.&lt;/p&gt;<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param &lt;E&gt; the type of the enumeration<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param enumClass  the class of the enum to query, not null<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param enumName   the enum name, null returns null<a name="line.104"></a>
<FONT color="green">105</FONT>         * @return the enum, null if not found<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; E getEnum(Class&lt;E&gt; enumClass, String enumName) {<a name="line.107"></a>
<FONT color="green">108</FONT>            if (enumName == null) {<a name="line.108"></a>
<FONT color="green">109</FONT>                return null;<a name="line.109"></a>
<FONT color="green">110</FONT>            }<a name="line.110"></a>
<FONT color="green">111</FONT>            try {<a name="line.111"></a>
<FONT color="green">112</FONT>                return Enum.valueOf(enumClass, enumName);<a name="line.112"></a>
<FONT color="green">113</FONT>            } catch (IllegalArgumentException ex) {<a name="line.113"></a>
<FONT color="green">114</FONT>                return null;<a name="line.114"></a>
<FONT color="green">115</FONT>            }<a name="line.115"></a>
<FONT color="green">116</FONT>        }<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>        /**<a name="line.118"></a>
<FONT color="green">119</FONT>         * &lt;p&gt;Creates a long bit vector representation of the given subset of an Enum.&lt;/p&gt;<a name="line.119"></a>
<FONT color="green">120</FONT>         *<a name="line.120"></a>
<FONT color="green">121</FONT>         * &lt;p&gt;This generates a value that is usable by {@link EnumUtils#processBitVector}.&lt;/p&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * &lt;p&gt;Do not use this method if you have more than 64 values in your Enum, as this<a name="line.123"></a>
<FONT color="green">124</FONT>         * would create a value greater than a long can hold.&lt;/p&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>         *<a name="line.125"></a>
<FONT color="green">126</FONT>         * @param enumClass the class of the enum we are working with, not {@code null}<a name="line.126"></a>
<FONT color="green">127</FONT>         * @param values    the values we want to convert, not {@code null}<a name="line.127"></a>
<FONT color="green">128</FONT>         * @param &lt;E&gt;       the type of the enumeration<a name="line.128"></a>
<FONT color="green">129</FONT>         * @return a long whose binary value represents the given set of enum values.<a name="line.129"></a>
<FONT color="green">130</FONT>         * @throws NullPointerException if {@code enumClass} or {@code values} is {@code null}<a name="line.130"></a>
<FONT color="green">131</FONT>         * @throws IllegalArgumentException if {@code enumClass} is not an enum class or has more than 64 values<a name="line.131"></a>
<FONT color="green">132</FONT>         * @since 3.0.1<a name="line.132"></a>
<FONT color="green">133</FONT>         */<a name="line.133"></a>
<FONT color="green">134</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; long generateBitVector(Class&lt;E&gt; enumClass, Iterable&lt;E&gt; values) {<a name="line.134"></a>
<FONT color="green">135</FONT>            checkBitVectorable(enumClass);<a name="line.135"></a>
<FONT color="green">136</FONT>            Validate.notNull(values);<a name="line.136"></a>
<FONT color="green">137</FONT>            long total = 0;<a name="line.137"></a>
<FONT color="green">138</FONT>            for (E constant : values) {<a name="line.138"></a>
<FONT color="green">139</FONT>                total |= 1 &lt;&lt; constant.ordinal();<a name="line.139"></a>
<FONT color="green">140</FONT>            }<a name="line.140"></a>
<FONT color="green">141</FONT>            return total;<a name="line.141"></a>
<FONT color="green">142</FONT>        }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>        /**<a name="line.144"></a>
<FONT color="green">145</FONT>         * &lt;p&gt;Creates a long bit vector representation of the given array of Enum values.&lt;/p&gt;<a name="line.145"></a>
<FONT color="green">146</FONT>         *<a name="line.146"></a>
<FONT color="green">147</FONT>         * &lt;p&gt;This generates a value that is usable by {@link EnumUtils#processBitVector}.&lt;/p&gt;<a name="line.147"></a>
<FONT color="green">148</FONT>         *<a name="line.148"></a>
<FONT color="green">149</FONT>         * &lt;p&gt;Do not use this method if you have more than 64 values in your Enum, as this<a name="line.149"></a>
<FONT color="green">150</FONT>         * would create a value greater than a long can hold.&lt;/p&gt;<a name="line.150"></a>
<FONT color="green">151</FONT>         *<a name="line.151"></a>
<FONT color="green">152</FONT>         * @param enumClass the class of the enum we are working with, not {@code null}<a name="line.152"></a>
<FONT color="green">153</FONT>         * @param values    the values we want to convert, not {@code null}<a name="line.153"></a>
<FONT color="green">154</FONT>         * @param &lt;E&gt;       the type of the enumeration<a name="line.154"></a>
<FONT color="green">155</FONT>         * @return a long whose binary value represents the given set of enum values.<a name="line.155"></a>
<FONT color="green">156</FONT>         * @throws NullPointerException if {@code enumClass} or {@code values} is {@code null}<a name="line.156"></a>
<FONT color="green">157</FONT>         * @throws IllegalArgumentException if {@code enumClass} is not an enum class or has more than 64 values<a name="line.157"></a>
<FONT color="green">158</FONT>         * @since 3.0.1<a name="line.158"></a>
<FONT color="green">159</FONT>         */<a name="line.159"></a>
<FONT color="green">160</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; long generateBitVector(Class&lt;E&gt; enumClass, E... values) {<a name="line.160"></a>
<FONT color="green">161</FONT>            Validate.noNullElements(values);<a name="line.161"></a>
<FONT color="green">162</FONT>            return generateBitVector(enumClass, Arrays.&lt;E&gt; asList(values));<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>        /**<a name="line.165"></a>
<FONT color="green">166</FONT>         * &lt;p&gt;Convert a long value created by {@link EnumUtils#generateBitVector} into the set of<a name="line.166"></a>
<FONT color="green">167</FONT>         * enum values that it represents.&lt;/p&gt;<a name="line.167"></a>
<FONT color="green">168</FONT>         *<a name="line.168"></a>
<FONT color="green">169</FONT>         * &lt;p&gt;If you store this value, beware any changes to the enum that would affect ordinal values.&lt;/p&gt;<a name="line.169"></a>
<FONT color="green">170</FONT>         * @param enumClass the class of the enum we are working with, not {@code null}<a name="line.170"></a>
<FONT color="green">171</FONT>         * @param value     the long value representation of a set of enum values<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param &lt;E&gt;       the type of the enumeration<a name="line.172"></a>
<FONT color="green">173</FONT>         * @return a set of enum values<a name="line.173"></a>
<FONT color="green">174</FONT>         * @throws NullPointerException if {@code enumClass} is {@code null}<a name="line.174"></a>
<FONT color="green">175</FONT>         * @throws IllegalArgumentException if {@code enumClass} is not an enum class or has more than 64 values<a name="line.175"></a>
<FONT color="green">176</FONT>         * @since 3.0.1<a name="line.176"></a>
<FONT color="green">177</FONT>         */<a name="line.177"></a>
<FONT color="green">178</FONT>        public static &lt;E extends Enum&lt;E&gt;&gt; EnumSet&lt;E&gt; processBitVector(Class&lt;E&gt; enumClass, long value) {<a name="line.178"></a>
<FONT color="green">179</FONT>            final E[] constants = checkBitVectorable(enumClass).getEnumConstants();<a name="line.179"></a>
<FONT color="green">180</FONT>            final EnumSet&lt;E&gt; results = EnumSet.noneOf(enumClass);<a name="line.180"></a>
<FONT color="green">181</FONT>            for (E constant : constants) {<a name="line.181"></a>
<FONT color="green">182</FONT>                if ((value &amp; 1 &lt;&lt; constant.ordinal()) != 0) {<a name="line.182"></a>
<FONT color="green">183</FONT>                    results.add(constant);<a name="line.183"></a>
<FONT color="green">184</FONT>                }<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>            return results;<a name="line.186"></a>
<FONT color="green">187</FONT>        }<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>        /**<a name="line.189"></a>
<FONT color="green">190</FONT>         * Validate that {@code enumClass} is compatible with representation in a {@code long}.<a name="line.190"></a>
<FONT color="green">191</FONT>         * @param &lt;E&gt; the type of the enumeration<a name="line.191"></a>
<FONT color="green">192</FONT>         * @param enumClass to check<a name="line.192"></a>
<FONT color="green">193</FONT>         * @return {@code enumClass}<a name="line.193"></a>
<FONT color="green">194</FONT>         * @throws NullPointerException if {@code enumClass} is {@code null}<a name="line.194"></a>
<FONT color="green">195</FONT>         * @throws IllegalArgumentException if {@code enumClass} is not an enum class or has more than 64 values<a name="line.195"></a>
<FONT color="green">196</FONT>         * @since 3.0.1<a name="line.196"></a>
<FONT color="green">197</FONT>         */<a name="line.197"></a>
<FONT color="green">198</FONT>        private static &lt;E extends Enum&lt;E&gt;&gt; Class&lt;E&gt; checkBitVectorable(Class&lt;E&gt; enumClass) {<a name="line.198"></a>
<FONT color="green">199</FONT>            Validate.notNull(enumClass, "EnumClass must be defined.");<a name="line.199"></a>
<FONT color="green">200</FONT>    <a name="line.200"></a>
<FONT color="green">201</FONT>            final E[] constants = enumClass.getEnumConstants();<a name="line.201"></a>
<FONT color="green">202</FONT>            Validate.isTrue(constants != null, "%s does not seem to be an Enum type", enumClass);<a name="line.202"></a>
<FONT color="green">203</FONT>            Validate.isTrue(constants.length &lt;= Long.SIZE, "Cannot store %s %s values in %s bits", constants.length,<a name="line.203"></a>
<FONT color="green">204</FONT>                enumClass.getSimpleName(), Long.SIZE);<a name="line.204"></a>
<FONT color="green">205</FONT>    <a name="line.205"></a>
<FONT color="green">206</FONT>            return enumClass;<a name="line.206"></a>
<FONT color="green">207</FONT>        }<a name="line.207"></a>
<FONT color="green">208</FONT>    }<a name="line.208"></a>




























































</PRE>
</BODY>
</HTML>
